home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / funnel.zoo / sources / data.h < prev    next >
C/C++ Source or Header  |  1993-04-11  |  27KB  |  513 lines
  1. /*##############################################################################
  2.  
  3. FUNNNELWEB COPYRIGHT
  4. ====================
  5. FunnelWeb is a literate-programming macro preprocessor.
  6.  
  7. Copyright (C) 1992 Ross N. Williams.
  8.  
  9.    Ross N. Williams
  10.    ross@spam.adelaide.edu.au
  11.    16 Lerwick Avenue, Hazelwood Park 5066, Australia.
  12.  
  13. This program is free software; you can redistribute it and/or modify
  14. it under the terms of Version 2 of the GNU General Public License as
  15. published by the Free Software Foundation.
  16.  
  17. This program is distributed WITHOUT ANY WARRANTY; without even the implied
  18. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19. See Version 2 of the GNU General Public License for more details.
  20.  
  21. You should have received a copy of Version 2 of the GNU General Public
  22. License along with this program. If not, you can FTP the license from
  23. prep.ai.mit.edu/pub/gnu/COPYING-2 or write to the Free Software
  24. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25.  
  26. Section 2a of the license requires that all changes to this file be
  27. recorded prominently in this file. Please record all changes here.
  28.  
  29. Programmers:
  30.    RNW  Ross N. Williams  ross@spam.adelaide.edu.au
  31.  
  32. Changes:
  33.    07-May-1992  RNW  Program prepared for release under GNU GPL V2.
  34.  
  35. ##############################################################################*/
  36.  
  37.  
  38. /******************************************************************************/
  39. /*                                    DATA.H                                  */
  40. /******************************************************************************/
  41. /*                                                                            */
  42. /* This package (data.h, data.c) contains ALL of the global variables in      */
  43. /* FunnelWeb. Some of the FunnelWeb packages (e.g. the lister) harbour hidden */
  44. /* static state variables which could be considered to be a global variable,  */
  45. /* but, these aside, this package contains all the variables that are used    */
  46. /* directly by more than one package. In many programs, it would likely be    */
  47. /* appropriate to have a separate package for each distinct group of shared   */
  48. /* data so that only those packages needing a particular group of data need   */
  49. /* see it. However, in FunnelWeb's case, the variables are so few, and their  */
  50. /* use so widespread that they are clustered here in one package for all to   */
  51. /* see.                                                                       */
  52. /*                                                                            */
  53. /* This package also contains type definitions for the central FunnelWeb data */
  54. /* structures.                                                                */
  55. /*                                                                            */
  56. /******************************************************************************/
  57.  
  58. /* Ensure that the body of this header file is included at most once.         */
  59. #ifndef DONE_DATA
  60. #define DONE_DATA
  61.  
  62. /******************************************************************************/
  63.  
  64. #include <stdio.h>
  65. #include <stdlib.h>
  66. #include <limits.h>
  67. #include "style.h"
  68. #include "clock.h"
  69. #include "list.h"
  70. #include "table.h"
  71. #include "option.h"
  72. #include "section.h"
  73. #include "writfile.h"
  74.  
  75. /******************************************************************************/
  76. /*                                                                            */
  77. /* DATA TYPES                                                                 */
  78. /* ==========                                                                 */
  79. /* The following section contains all the data types of the global variables. */
  80. /*                                                                            */
  81. /******************************************************************************/
  82.  
  83. /* The following structure defines a position in the global listing of the    */
  84. /* input data by storing a line number and a column number. The line number   */
  85. /* is a global line number meaning that it increases continuously through     */
  86. /* the lines of included files. The first line is line number 1. The first    */
  87. /* (leftmost) column is column number 1.                                      */
  88. typedef
  89.    struct
  90.      {
  91.       ulong ps_line;
  92.       ulong ps_column;
  93.      } ps_t ;
  94.  
  95. typedef ps_t *p_ps_t;  /* A pointer to a position is handy too! */
  96.  
  97. /******************************************************************************/
  98.  
  99. /* A macro name is represented simply as a character array. */
  100. #define NAME_MAX 80
  101. typedef char name_t[NAME_MAX+1];
  102. typedef name_t *p_name_t;
  103.  
  104. /******************************************************************************/
  105.  
  106. /* SC stands for SCrap of text. A scrap of text is a contiguous group of      */
  107. /* printable bytes in memory. The following structure defines such a group by */
  108. /* storing a pointer to the first and last character of the scrap.            */
  109. /* The scrap must contain at least one character (i.e. sc_last>=sc_first).    */
  110. typedef
  111.    struct
  112.      {
  113.       char *sc_first; /* Pointer to the first byte of the scrap.              */
  114.       char *sc_last;  /* Pointer to the last  byte of the scrap.              */
  115.       bool  sc_white; /* TRUE iff the scrap consists entirely of whitespace.  */
  116.      } sc_t;
  117.  
  118. typedef sc_t *p_sc_t;
  119.  
  120. /******************************************************************************/
  121.  
  122. /* LN stands for LiNe. This record holds global and local line numbers as     */
  123. /* well as a scrap that points to the line in question. The scanner (which    */
  124. /* generates this list) guarantees that the last character of the line scrap  */
  125. /* is an EOL.                                                                 */
  126. typedef
  127.    struct
  128.      {
  129.       sc_t  ln_body;    /* Scrap pointing to the line. Line ends in EOL.      */
  130.       ulong ln_global;  /* Global line number of this line.                   */
  131.       ulong ln_local;   /* Local  line number of this line.                   */
  132.      } ln_t;
  133.  
  134. /* The global line list is simply a list of lines of the following type.      */
  135. typedef p_ls_t p_lnls_t;
  136.  
  137. /******************************************************************************/
  138.  
  139. /* The following enumerated type identifies a font. */
  140. #define FT_NORM 1
  141. #define FT_TITL 2
  142. #define FT_STIT 3
  143.  
  144. /* The following enumerated type identifies a horizontal alignment. */
  145. #define LR_LEFT 1
  146. #define LR_RIGH 2
  147. #define LR_CENT 3
  148.  
  149. /* We want to pack a font and an alignment into the tk_gen byte of the token  */
  150. /* record (we could create a new field, but as none of the other token kinds  */
  151. /* require an extra field, we choose to pack instead. The formula is this:    */
  152. /* Packed byte=LRFT_PACK*FONT+ALIGNMENT.                                      */
  153. #define LRFT_PACK 10
  154.  
  155. /******************************************************************************/
  156.  
  157. /* The following enumerated type identifies the kind of a token. */
  158. #define TK_TEXT  1   /*      Text segment.          */
  159. #define TK_NSEC  2   /*  @A..New section.           */
  160. #define TK_MDEF  3   /*  @$  Macro definition.      */
  161. #define TK_FDEF  4   /*  @F  File definition.       */
  162. #define TK_ONAM  5   /*  @<  Open name.             */
  163. #define TK_CNAM  6   /*  @>  Close name.            */
  164. #define TK_ODEF  7   /*  @{  Open definition.       */
  165. #define TK_CDEF  8   /*  @}  Close definition.      */
  166. #define TK_OPAR  9   /*  @(  Open parameter list.   */
  167. #define TK_CPAR 10   /*  @)  Close parameter list.  */
  168. #define TK_COMA 11   /*  @,  Comma.                 */
  169. #define TK_QUOT 12   /*  @"  Quote.                 */
  170. #define TK_PARM 13   /*  @1  Parameter.             */
  171. #define TK_ZERO 14   /*  @Z  Zero calls allowed.    */
  172. #define TK_MANY 15   /*  @M  Many calls allowed.    */
  173. #define TK_NAME 16   /*  @#  Self contained name.   */
  174. #define TK_EMPH 17   /*  @/  Emphasize text.        */
  175. #define TK_NPAG 18   /*  @t..Newpage.               */
  176. #define TK_TOCS 19   /*  @t..Table of contents.     */
  177. #define TK_SKIP 20   /*